Skip to content

DOC: DataFrame.from_records accepts an Iterable of data in the implementation, which is not specified in the docs #62430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 24, 2025
Merged

DOC: DataFrame.from_records accepts an Iterable of data in the implementation, which is not specified in the docs #62430

merged 1 commit into from
Sep 24, 2025

Conversation

@cmp0xff
Copy link
Contributor

@cmp0xff cmp0xff commented Sep 24, 2025

This PR originates from pandas-dev/pandas-stubs#1376, where people recognised that DataFrame.from_records supports an Iterable of data (see below), which is not specified in the current documentation.

pandas/pandas/core/frame.py

Lines 2240 to 2263 in f6fa9b6

if is_iterator(data):
if nrows == 0:
return cls(index=index, columns=columns)
try:
first_row = next(data)
except StopIteration:
return cls(index=index, columns=columns)
dtype = None
if hasattr(first_row, "dtype") and first_row.dtype.names:
dtype = first_row.dtype
values = [first_row]
if nrows is None:
values += data
else:
values.extend(itertools.islice(data, nrows - 1))
if dtype is not None:
data = np.array(values, dtype=dtype)
else:
data = values

@mroeschke mroeschke added the Docs label Sep 24, 2025
@mroeschke mroeschke added this to the 3.0 milestone Sep 24, 2025
@mroeschke mroeschke merged commit 98c9c7f into pandas-dev:main Sep 24, 2025
46 of 47 checks passed
@mroeschke
Copy link
Member

Thanks @cmp0xff

jzwick pushed a commit to jzwick/pandas that referenced this pull request Oct 1, 2025
@cmp0xff
DOC: DataFrame.from_records accepts an Iterable of data in the implem…
58526f9 
…entation, which is not specified in the docs (pandas-dev#62430)
@cmp0xff cmp0xff deleted the hotfix/cmp0xff/df-from-records-iterable-data branch October 3, 2025 08:35
eicchen pushed a commit to eicchen/pandas that referenced this pull request Oct 18, 2025
@cmp0xff @eicchen
DOC: DataFrame.from_records accepts an Iterable of data in the implem…
e364808 
…entation, which is not specified in the docs (pandas-dev#62430)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

Docs

Projects

None yet

Milestone

3.0

Development

Successfully merging this pull request may close these issues.

2 participants

@cmp0xff @mroeschke